/*******************************************************************************
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *  
 * Copyright (c) 2011 Michael Chan.
 ******************************************************************************/
package com.google.code.solrdimension.indexmodifiers;

import org.apache.solr.common.SolrInputDocument;

import com.google.code.solrdimension.config.DimensionConfigWrapper;
import com.google.code.solrdimension.config.dimension.DimensionConfig;
import com.google.code.solrdimension.config.dimensionvalue.AbstractDimensionValueConfig;

/**
 * Modifies the {@link SolrInputDocument} according to the configurations in {@link DimensionConfig}
 * 
 * @author mhc
 *
 */
public interface IndexModService {
    
    /**
     * Modify the index with the given {@link AbstractDimensionValueConfig}
     * @param config
     *      An instance of type {@link AbstractDimensionValueConfig}
     * @param inputDoc
     *      {@link SolrInputDocument}
     * @param objectToIndex
     *      The object to index
     * @param field
     *      The field to be added to the solr input document
     * @return
     *      True if this is successful, false otherwise
     */
    public boolean modifyIndex(AbstractDimensionValueConfig config, SolrInputDocument inputDoc, Object objectToIndex, String field);
    
    /**
     * Returns an appropiate instance of type IndexModAction for the DimensionValueConfig
     * @param dimensionValueConfig
     * @return
     */
    public IndexModAction getIndexModAction(AbstractDimensionValueConfig dimensionValueConfig);

}
